Skip to content

chore: add api docs in mkdocs build #3715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2025
Merged

chore: add api docs in mkdocs build #3715

merged 2 commits into from
Mar 12, 2025

Conversation

dreamorosi
Copy link
Contributor

Summary

Changes

Please provide a summary of what's being changed

This PR adds a new mkdocs-typedoc plugin to our docs so that when running mkdocs serve (local dev) or mkdocs build (CI) it builds the API reference using TypeDoc in addition to the main docs.

This will simplify the CI setup (I updated the workflow) but most importantly it also improves the authoring experience which now requires a single command to run everything.

As part of the PR, I also moved the API reference link in the main header, so it's more prominent.

image

Finally, I have tweaked the mkdocs.yml configuration so that whenever we update any (and mkdocs serve is running), it'll trigger an automatic reload - this was not the case for snippets and API reference before.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #3714


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Mar 12, 2025
@boring-cyborg boring-cyborg bot added automation This item relates to automation dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Mar 12, 2025
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Mar 12, 2025
@dreamorosi dreamorosi requested a review from am29d March 12, 2025 15:28
@am29d am29d merged commit 6e19415 into main Mar 12, 2025
54 checks passed
@am29d am29d deleted the chore/api_docs_mkdocs branch March 12, 2025 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: build API Docs as part of main docs
2 participants